/* 
 * Copyright [2018] [Alex/libo(liboms@hotmail.com)]
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.hyts.apidoc.model;

import com.alibaba.fastjson.JSONObject;
import com.alibaba.fastjson.annotation.JSONField;

/**
 * @title ApiParam.java  
 * @package com.hyts.apidoc.model  
 * @description API接口操作参数信息：输入参数和输出参数保持一直的数据结构 
 * @see TODO
 * @author libo/Alex
 * @email liboms@hotmail.com/liboware@163.com  
 * @date 2018年4月18日 
 * @version V1.0 
 */
public class ApiParam {

	/**  
	 * <p>参数名称</p> 
	 * @fieldName paramName
	 * @fieldType String
	 */
	@JSONField(serialize = false)
	private String paramName;
	
	/**  
	 * <p>参数类型</p> 
	 * @fieldName paramType
	 * @fieldType String
	 */
	private String paramType;
	
	/**  
	 * <p>参数描述</p> 
	 * @fieldName paramDescription
	 * @fieldType String
	 */
	@JSONField(serialize = false)
	private String paramDescription;
	
	/**  
	 * <p>是否必填项</p> 
	 * @fieldName isRequired
	 * @fieldType String
	 */
	@JSONField(serialize = false)
	private String isRequired;

	/**  
	 * @name paramName's getter method
	 * @param none
	 * @return paramName
	 */
	public String getParamName() {
		return paramName;
	}

	/**  
	 * @name paramName's setter method
	 * @param paramName
	 * @return void
	 */
	public void setParamName(String paramName) {
		this.paramName = paramName;
	}

	/**  
	 * @name paramType's getter method
	 * @param none
	 * @return paramType
	 */
	public String getParamType() {
		return paramType;
	}

	/**  
	 * @name paramType's setter method
	 * @param paramType
	 * @return void
	 */
	public void setParamType(String paramType) {
		this.paramType = paramType;
	}

	/**  
	 * @name paramDescription's getter method
	 * @param none
	 * @return paramDescription
	 */
	public String getParamDescription() {
		return paramDescription;
	}

	/**  
	 * @name paramDescription's setter method
	 * @param paramDescription
	 * @return void
	 */
	public void setParamDescription(String paramDescription) {
		this.paramDescription = paramDescription;
	}

	/**  
	 * @name isRequired's getter method
	 * @param none
	 * @return isRequired
	 */
	public String getIsRequired() {
		return isRequired;
	}

	/**  
	 * @name isRequired's setter method
	 * @param isRequired
	 * @return void
	 */
	public void setIsRequired(String isRequired) {
		this.isRequired = isRequired;
	}


	@Override
	public String toString() {
		return JSONObject.toJSONString(this);
	}
}
